home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / MrmFetchBitmapLiteral.z / MrmFetchBitmapLiteral
Encoding:
Text File  |  2002-10-03  |  6.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll - Fetches a bitmap literal from a
  10.           hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Mrm/MrmPublic.h>
  14.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll(
  15.           MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,
  16.           SSSSttttrrrriiiinnnngggg iiiinnnnddddeeeexxxx,
  17.           SSSSccccrrrreeeeeeeennnn ****ssssccccrrrreeeeeeeennnn,
  18.           DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,
  19.           PPPPiiiixxxxmmmmaaaapppp ****ppppiiiixxxxmmmmaaaapppp____rrrreeeettttuuuurrrrnnnn,
  20.           DDDDiiiimmmmeeeennnnssssiiiioooonnnn ****wwwwiiiiddddtttthhhh,
  21.           DDDDiiiimmmmeeeennnnssssiiiioooonnnn ****hhhheeeeiiiigggghhhhtttt);
  22.  
  23.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  24.           This page documents Motif 2.1.
  25.  
  26.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.           The MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll function fetches a bitmap literal
  28.           from an MRM hierarchy, and converts the bitmap literal to an
  29.           X pixmap of depth 1. The function returns this pixmap and
  30.           its width and height.
  31.  
  32.           _h_i_e_r_a_r_c_h_y__i_d
  33.                     Specifies the ID of the UID hierarchy that
  34.                     contains the specified icon literal. The value of
  35.                     _h_i_e_r_a_r_c_h_y__i_d was returned in a previous call to
  36.                     MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.
  37.  
  38.           _i_n_d_e_x     Specifies the UIL name of the bitmap literal to
  39.                     fetch.
  40.  
  41.           _s_c_r_e_e_n    Specifies the screen used for the pixmap.  The
  42.                     _s_c_r_e_e_n argument specifies a pointer to the Xlib
  43.                     structure SSSSccccrrrreeeeeeeennnn which contains the information
  44.                     about that screen and is linked to the DDDDiiiissssppppllllaaaayyyy
  45.                     structure.  For more information on the DDDDiiiissssppppllllaaaayyyy
  46.                     and SSSSccccrrrreeeeeeeennnn structures, see the Xlib function
  47.                     XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy and the associated screen information
  48.                     macros.
  49.  
  50.           _d_i_s_p_l_a_y   Specifies the display used for the pixmap.  The
  51.                     _d_i_s_p_l_a_y argument specifies the connection to the X
  52.                     server.  For more information on the DDDDiiiissssppppllllaaaayyyy
  53.                     structure, see the Xlib function XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy.
  54.  
  55.           _p_i_x_m_a_p__r_e_t_u_r_n
  56.                     Returns the resulting X pixmap value.  The
  57.                     function allocates space for this pixmap.  The
  58.                     application is responsible for managing the
  59.                     allocated space.  The application can recover the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     allocated space by calling XXXXmmmmDDDDeeeessssttttrrrrooooyyyyPPPPiiiixxxxmmmmaaaapppp.
  75.  
  76.           _w_i_d_t_h     Specifies a pointer to the width of the pixmap.
  77.  
  78.           _h_e_i_g_h_t    Specifies a pointer to the height of the pixmap.
  79.  
  80.      RRRREEEETTTTUUUURRRRNNNN
  81.           This function returns one of the following status return
  82.           constants:
  83.  
  84.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS
  85.                     The function executed successfully.
  86.  
  87.           MMMMrrrrmmmmBBBBAAAADDDD____HHHHIIIIEEEERRRRAAAARRRRCCCCHHHHYYYY
  88.                     The hierarchy ID was invalid.
  89.  
  90.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD
  91.                     The bitmap literal was not found in the hierarchy.
  92.  
  93.           MMMMrrrrmmmmWWWWRRRROOOONNNNGGGG____TTTTYYYYPPPPEEEE
  94.                     The caller tried to fetch a literal of a type not
  95.                     supported by this function.
  96.  
  97.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE
  98.                     The function failed.
  99.  
  100.      RRRREEEELLLLAAAATTTTEEEEDDDD
  101.           MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll(3), MMMMrrrrmmmmFFFFeeeettttcccchhhhLLLLiiiitttteeeerrrraaaallll(3), and
  102.           XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy(3).
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.